home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir41 / x10xa200.zip / USAGE.XA < prev    next >
Text File  |  1993-10-16  |  15KB  |  375 lines
  1. DISPLAY ON  # ! ! ! ! ! !   DO NOT MODIFY THIS FILE   ! ! ! ! ! ! 
  2.  
  3.     ┌───────────────────────────────────────────────────────────────────┐
  4.     │       Welcome to the XA Command Interpreter ─ Version 2.0         │
  5.     │   Copyright 1991─1993 by Bruce Christensen. All Rights Reserved.  │
  6.     └───────────────────────────────────────────────────────────────────┘
  7.  
  8.  XA is a versatile command interpreter capable of translating English-like
  9.  sentences into commands for the X10 Computer Interface (CP-290). XA can send
  10.  direct commands (for example: "PORCH_LIGHT ON"),  or utilize the CP-290's 
  11.  event storage for later execution ("PORCH_LIGHT ON EVERYDAY SUNSET").
  12.  
  13.  XA can read commands directly from the DOS prompt, or read a series of 
  14.  commands and events from a text file. The former method is useful for 
  15.  activating modules directly from the keyboard or within a batch file, the
  16.  later method is handy for maintaining your CP-290 event schedules.
  17.  
  18.         DOS command line mode:  C:\> XA "A1 ON"
  19.                or,  file mode:  C:\> XA f=filename.cmd
  20.  
  21.  Please read the XA User's Guide and Reference manual for full details.
  22.  
  23.  Press the <ESC> key to EXIT this screen and return to DOS, or
  24.  Press any other key for ADDITIONAL HIGHTLIGHTS and FEATURES of XA.
  25.  
  26. pause 
  27.  
  28.  
  29.  
  30.  XA HIGHLIGHTS
  31.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  32.  
  33.  XA Version 2.0 includes the following features:
  34.  
  35.    * IF/ELSE conditional programming 
  36.    * Powerfail Recovery
  37.    * Enhanced DATE programming (new EXCEPT token)
  38.    * Arithmetic, Logical, Boolean, Assignment OPERATORS
  39.    * User-defined VARIABLES
  40.    * Automatic EVENT appending to existing schedules
  41.    * Support for CP-290 "undocumented" commands ALL_LIGHTS_ON, ALL_UNITS_OFF
  42.    * ...plus the standard features like SUNRISE, SUNSET, MONITOR, LOG 
  43.      and much, much more...
  44.  
  45.   Please read the XA User's Guide and Reference manual for full details.
  46.  
  47.   Press the <ESC> key to EXIT this screen and return to DOS, or
  48.   Press any other key for XA's Syntax and Command Line Arguments.
  49.  
  50. pause 
  51.  
  52.  
  53.  SYNTAX ─ COMMAND LINE ARGUMENTS
  54.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  55.  
  56.     ┌──────────────────────────────────────────────────────────────┐
  57.     │   XA [f=filename] [c=comm port] [i=irq] [io=io addr] [-e]    │
  58.     │      [+l] [+m] [-p] [+p] [+r1] [+r2] [/?] ["commands"...]    │
  59.     └──────────────────────────────────────────────────────────────┘
  60.  
  61.      where: 
  62.          f=filename  ─ file containing the commands and events
  63.  
  64.          c=comm port ─ selects the serial port used by the CP-290.
  65.  
  66.          i=irq       ─ selects a different IRQ interrupt from the default 4.
  67.  
  68.          o=io_addrH  ─ selects a different IO address from the default 3F8H.
  69.  
  70.          -e          ─ prevents communications to the CP-290.
  71.  
  72.    Please read the XA User's Guide and Reference manual for full details.
  73.  
  74.    Press the <ESC> key to EXIT this screen and return to DOS, or
  75.    Press any other key for additional Command Line Arguments.
  76. pause 
  77.  
  78.  
  79.  
  80.  SYNTAX ─ COMMAND LINE ARGUMENTS (continued)
  81.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  82.    
  83.     ┌──────────────────────────────────────────────────────────────┐
  84.     │   XA [f=filename] [c=comm port] [i=irq] [io=io addr] [-e]    │
  85.     │      [+l] [+m] [-p] [+p] [+r1] [+r2] [/?] ["commands"...]    │
  86.     └──────────────────────────────────────────────────────────────┘
  87.  
  88.      where: 
  89.          +l          ─ monitors and logs events to file XA.LOG.
  90.          +m          ─ monitors events as CP-290 executes them.
  91.          +p          ─ powerfail recovery (parses XACMD file first).
  92.          -p          ─ powerfail recovery (no command file parsing).
  93.          +r1, +r2    ─ creates XA.RPT in two different styles.
  94.          /?, /h, /H  ─ displays these help screens.
  95.  
  96.          "commands"  ─ direct commands or events to be sent to CP-290.
  97.  
  98.    Please read the XA User's Guide and Reference manual for full details.
  99.  
  100.    Press the <ESC> key to EXIT this screen and return to DOS, or
  101.    Press any other key for examples of Command Line Arguments.
  102.  
  103. pause 
  104.  
  105.  
  106.  COMMAND LINE ARGUMENTS EXAMPLES
  107.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  108.    
  109.    * To execute direct commands (note QUOTATION marks):
  110.          XA "A1 ON"                
  111.  
  112.    * To execute multiple direct commands:
  113.          XA "A1 ON" "A1 OFF" "HOUSE B ALL_UNITS_OFF"
  114.  
  115.    * Execute commands from a file, specify COM3, and create report file:
  116.          XA c=3 f=XA.CMD +r1
  117.    
  118.    * Send an event to CP-290 for later execution:
  119.          XA "PORCH ON SUNSET WEEKDAYS"   (Note: PORCH defined as A9 in XA.INI)
  120.  
  121.  
  122.  
  123.    Please read the XA User's Guide and Reference manual for full details.
  124.  
  125.    Press the <ESC> key to EXIT this screen and return to DOS, or
  126.    Press any other key for TOKEN SYNOPSIS.
  127.  
  128. pause 
  129.  
  130.  
  131.  
  132.  TOKEN SYNOPSIS
  133.  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  134.  
  135.  Action tokens
  136.  ───────────────────────────────────────────────────────────────────────
  137.    ON       ─ turns ON the specified modules.
  138.    OFF      ─ turns OFF the specified modules.
  139.    {DIM %%} ─ DIM to a % (percentage) level of brightness.
  140.    {ALL_UNITS_OFF HOUSE x} 
  141.             ─ turns OFF all modules on selected HOUSEcode.
  142.    {ALL_LIGHTS_ON HOUSE x} 
  143.             ─ turns ON all lamp/wallswitch modules on selected HOUSEcode.
  144.  
  145.  Module address tokens
  146.  ───────────────────────────────────────────────────────────────────────
  147.    A1...P16  ─ HOUSE UNIT combined
  148.    {HOUSE x} ─ module HOUSEcode A...P
  149.    {UNIT z}  ─ module UNITcode 1...16, ALL
  150.  
  151.  Powerfail Recovery module status overrides
  152.  ───────────────────────────────────────────────────────────────────────
  153.    {IGNORE HOUSE UNIT}       ─ Leave module in its present state
  154.    {FORCE HOUSE-UNIT action} ─ Force module to ON, OFF, DIM state
  155. pause
  156.  
  157.  
  158.  Coordinate tokens
  159.  ───────────────────────────────────────────────────────────────────────
  160.    {LATITUDE dms}  ─ your LATITUDE in Degrees and Minutes
  161.    {LONGITUDE dms} ─ your LONGITUDE in Degrees and Minutes
  162.    {TIMEZONE x}          ─ your TIMEZONE (Standard/Daylight Savings)
  163.    DST                   ─ Automatic Daylight Savings adjustments     
  164.  
  165.  Clock tokens
  166.  ───────────────────────────────────────────────────────────────────────
  167.    {SYNCHRONIZE PC (EXACT)}  ─ set PC time based on X10 time
  168.    {SYNCHRONIZE X10 (EXACT)} ─ set X10 time based on PC time
  169.  
  170.  Time tokens
  171.  ───────────────────────────────────────────────────────────────────────
  172.    {TIME hh:mm (AM)(PM)} ─ Schedule event time
  173.    SUNRISE               ─ Calculate time of sunrise
  174.    SUNSET                ─ Calculate time of sunset
  175.    {OFFSET +/-hh:mm}     ─ Event occurs +/- 23h59m of prog time
  176.    NORMAL                ─ Event occurs at specified time
  177.    SECURITY              ─ Event occurs within the hour
  178.    {RANDOM +/-hh:mm}     ─ Event occurs within a random offset +/-23h59m.
  179.    {NOW hh:mm}           ─ Event occurs with respect to current time.
  180.  
  181. pause
  182.  
  183.  
  184.  
  185.   Day tokens
  186.  ───────────────────────────────────────────────────────────────────────
  187.    SUNDAY, SUN       ─ Specific day for event to occur
  188.    MONDAY, MON       ─             "
  189.    TUESDAY, TUE      ─             "
  190.    WEDNESDAY, WED    ─             "
  191.    THURSDAY, THU     ─             "
  192.    FRIDAY, FRI       ─             "
  193.    SATURDAY, SAT     ─             "
  194.    EVERYDAY          ─ Event occurs everyday
  195.    TODAY             ─ Event occurs once today only
  196.    TOMORROW          ─ Event occurs once tomorrow only
  197.    WEEKDAY, WEEKDAYS ─ Event occurs only on weekdays
  198.    WEEKEND, WEEKENDS ─ Event occurs only on weekends
  199.  
  200.  Pre-defined Variables
  201.  ───────────────────────────────────────────────────────────────────────
  202.   CDAY  ─ The current day
  203.   CTIME ─ The current time
  204.   CDATE ─ The current date
  205.  
  206. pause
  207.  
  208.  
  209.  
  210.  Specific Date tokens
  211.  ───────────────────────────────────────────────────────────────────────
  212.    {DATE mm/dd/yyyy}   
  213.               ─ Event occurs on specified date
  214.    {DATE mm/dd/yyyy THRU mm/dd/yyyy (SUNDAY...SATURDAY)}
  215.               ─ Event occurs between two dates
  216.    {EXCEPT DATE mm/dd/yyyy}   
  217.               ─ Event does NOT occur on specified date
  218.    {EXCEPT DATE mm/dd/yyyy THRU mm/dd/yyyy (SUNDAY...SATURDAY)}
  219.               ─ Event does NOT occur between two dates
  220.    {DATE mm/dd/yyyy THRU mm/dd/yyyy EXCEPT DATE mm/dd/yyyy THRU mm/dd/yyyy}
  221.               ─ Special exceptions within a given range.
  222.  
  223.  Communication tokens
  224.  ───────────────────────────────────────────────────────────────────────
  225.    {COMx}  ─ send commands via COM1...COM4
  226.    {IRQ x} ─ customize IRQ level for port.
  227.    {IO xH}  ─ customize port address (in hex).
  228.  
  229.  
  230. pause
  231.  
  232.  
  233.  
  234.  Miscellaneous tokens
  235.  ───────────────────────────────────────────────────────────────────────
  236.    {BASECODE x}      ─ Change BASECODE to A...P
  237.    {DEFINE x z}      ─ Substitute string 'x' for 'z'
  238.    {XACMD file.cmd}  ─ Specify default command file.
  239.    {INCLUDE filenme} ─ Specify another file to parse.
  240.    {CLEAR EVENT xxx} ─ Clear event xxx from CP-290 memory
  241.    {EVENT xxx}       ─ Place event xxx in a known location of CP-290 memory
  242.    {DOS command}     ─ Shell to DOS
  243.    {DISPLAY ON/OFF}  ─ Turn XA output display on or off.
  244.    BEEP              ─ Causes PC speaker to beep.
  245.    ERASE             ─ Erase ALL events from CP-290 memory
  246.    DIAGNOSE          - CP-290 performs internal diagnostics.
  247.  
  248.  Reporting tokens
  249.  ───────────────────────────────────────────────────────────────────────
  250.    LOG     ─ Append event info to file XA.LOG
  251.    MONITOR ─ Watch events as the CP-290 executes them.
  252.    REPORT1 ─ Produce report file based on daily events.
  253.    REPORT2 ─ Produce report file based on a module by module basis.
  254.  
  255. pause
  256.  
  257.  Direct Command Control Tokens
  258.  ───────────────────────────────────────────────────────────────────────
  259.    :LABEL           ─ Identify an area to "goto/gosub" later.
  260.    {GOTO label}     ─ Jump to location identified by "label".
  261.    {GOSUB label}    ─ Execute subroutine identified by "label".
  262.    RETURN           ─ from subroutine (used with GOSUB).
  263.    STOP             ─ Force XA to stop execution
  264.    :EXIT            ─ Special shutdown location jumped to when <ESC> pressed.
  265.    {DELAY hh:mm:ss} ─ Wait for time to pass before executing the next cmd.
  266.    PAUSE            ─ Halt execution of direct commands until key pressed, 
  267.                       then reset internal timer and resume direct commands.
  268.    {TIMER hh:mm:ss} ─ Wait until time elapses (relative to the internal timer).
  269.    RESET            ─ Reset internal timer.
  270.    FAST             ─ ignore ack message from CP-290, speeds up single cmds.
  271.  
  272.  Conditional Expressions  ( ** Registered Version Only ** )
  273.  ───────────────────────────────────────────────────────────────────────
  274.    IF (expression) ─  When expression evaluates TRUE...
  275.      statements       ...execute the following statements
  276.    [ELSE           ─  Otherwise... 
  277.      statements]      ...optionally execute the following statements
  278.    ENDIF           ─  Must always terminate conditonal statements.
  279. pause
  280.  
  281.  
  282.  Arithmetic Operators  ( ** Registered Version Only ** )
  283.  ───────────────────────────────────────────────────────────────────────
  284.    *        Multiply        A = B * C
  285.    /        Divide          B = A / C
  286.    +        Addition        C = A + B
  287.    -        Subtraction     A = C - B
  288.    -        Unary minus     A = -B
  289.  
  290.  
  291.  
  292.  Relational Operators  ( ** Registered Version Only ** )
  293.  ───────────────────────────────────────────────────────────────────────
  294.    =        Assign
  295.    <        Less than
  296.    >        Greater than
  297.    <=       Less than or equal to
  298.    <>       Not equal to
  299.    >=       Greater than or equal to
  300.    ==       Equals (not to be confused with '=' assignment operator)
  301.  
  302.  
  303. pause
  304.  
  305.  Logical Operators ( ** Registered Version Only ** )
  306.  ───────────────────────────────────────────────────────────────────────
  307.    AND      Logical AND
  308.    &&       Logical AND
  309.    OR       Logical OR
  310.    ||       Logical OR 
  311.    !        NOT
  312.     ┌───────────────────────────────────────────────────────────────────┐
  313.     │    A        B        A AND B       A OR B          !A             │
  314.     ├───────────────────────────────────────────────────────────────────┤
  315.     │    0        0           0             0             1             │
  316.     │    0        1           0             1             1             │
  317.     │    1        0           0             1             0             │
  318.     │    1        1           1             1             0             │
  319.     └───────────────────────────────────────────────────────────────────┘
  320.                    Truth Table for boolean operators
  321.  
  322.  
  323.  Bitwise Logical Operators ( ** Registered Version Only ** )
  324.  ───────────────────────────────────────────────────────────────────────
  325.   &        Bit "AND"
  326.   |        Bit "OR"
  327. pause
  328.  
  329.  Screen Color Control  ( ** Registered Version Only ** )
  330.  ───────────────────────────────────────────────────────────────────────
  331.    {VIDEO1 Foreground Background}  ─ IF or ELSE evaluates to TRUE
  332.    {VIDEO2 Foreground Background}  ─ IF or ELSE evaluates to FALSE
  333.    {VIDEO3 Foreground Background}  ─ Sending DIRECT commands to CP-290
  334.    {VIDEO4 Foreground Background}  ─ Sending EVENTS to CP-290
  335.  
  336.        where FOREGROUND may be any of the following:
  337.                BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, BROWN,
  338.                LIGHTGRAY, DARKGRAY, LIGHTBLUE, LIGHTGREEN, 
  339.                LIGHTCYAN, LIGHTRED, LIGHTMAGENTA, YELLOW, WHITE
  340.  
  341.        and BACKGROUND may be any of the following:
  342.                BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, BROWN, LIGHTGRAY
  343.  
  344.  I/O Port Control  ( ** Registered Version Only ** )
  345.  ───────────────────────────────────────────────────────────────────────
  346.    {(variable =) INPORT io_port}  ─ read status of port
  347.    {OUTPORT io_port value}        ─ output value to port 
  348.  
  349.  
  350. pause
  351.  
  352.   ┌───────────────────────────────────────────────────────────────────┐
  353.   │                        SUPPORT SHAREWARE                          │
  354.   │                     BECOME A REGISTERED USER                      │
  355.   └───────────────────────────────────────────────────────────────────┘
  356.  
  357.  
  358.  If you are already a registered user, thanks for your support. If you would
  359.  like to become a registered user, please fill out the "REGISTER.TXT" form
  360.  included with this package and mail to the address below. You will receive
  361.  the latest complete version of XA along with a printed User's Guide.
  362.  
  363.  XA continues to evolve based on suggestions from users. By registering
  364.  this software, you will also be able to receive future versions at very 
  365.  special update prices. 
  366.   
  367.  ┌───────────────────────────────────────────────────────────────────────┐
  368.  │ Bruce Christensen                 Prodigy ID     :  MHNC39A           │
  369.  │ 6594 Hudson Ave.                  America On-Line:  AuggieBen         │
  370.  │ Mentor, OH. 44060-4545            Internet (AOL) :  auggieben@aol.com │
  371.  └───────────────────────────────────────────────────────────────────────┘
  372.  
  373.  
  374. pause
  375.